ReadAxisInputs

Reads a value from an input of an axis.

Syntax

KsError ReadAxisInputs(
     int Index,
     DWORD* Value
);

Parameters

Index: the index of an axis. Indexes are zero based. Aliases affect this parameter.

Value: pointer to the buffer to receive the digital input.

Return value

If the function succeeds, it returns errNoError, otherwise an error code. For more information about the error code, see the KsError list.

Remarks

Used in the cyclic callback to check the digital inputs of an axis.

NOTE:  The digital input is available only if EnableAxisInput is enabled.

Usable EtherCAT states

ecatOP

Example

Copy
DWORD inputRead = 0;
nRet = ReadAxisInputs(0, &inputRead);

Requirements

  RT Win32
Minimum supported version 4.0 4.0
Header ksapi.h ksapi.h
Library KsApi_Rtss.lib KsApi.lib

See also

ReadAxisCustomInput1

ReadAxisCustomInput2

ReadAxisOutputs

WriteAxisCustomOutput1

WriteAxisCustomOutput2

WriteAxisOutputs